List Location Profiles
Returns Location Profiles of one warehouse specified by its id path parameter, with
publication status, revision snapshots, the ordered match definition, and live usage
counts.
The response meta carries the warehouse-level membership repair freshness
(membership_status, membership_current, membership_repaired_at).
The match clauses keep selected Location Tags and Slot Types as compact {type, id}
references. For an editor, request fields=location_tags,slot_types together with
fields:location_tags=name,color and fields:slot_types=name,is_pickable to resolve
only those direct selections through included.
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the referenced Warehouse.
Query Parameters
Specify additional fields of the LocationProfile object to be included in the response.
all, name, description, status, member_count, match, match_readable, location_tags, slot_types, active_revision, pending_revision, used_by, created_at, updated_at Specify fields of the directly referenced LocationTag objects to include under included.LocationTag. Add location_tags to the root fields parameter to return the relationship. type and id are always returned.
Specify additional fields of the LocationTag object to be included in the response.
basic, all, name, description, color, sort_order, is_deleted, created_at, updated_at Specify fields of the directly referenced SlotType objects to include under included.SlotType. Add slot_types to the root fields parameter to return the relationship. type and id are always returned.
Specify additional fields of the SlotType object to be included in the response.
basic, all, name, is_pickable, sort_order, patterns, is_fixed_capacity, slot_dimensions, weight_capacity, created_at, updated_at Using the filtering syntax, you may filter the results using the following fields:
idnamestatus
status is derived from the profile's revision pointers rather than stored, so it supports
only the eq and in operators. List the states you want instead of negating.
The default sort order is ascending by primary key (sort=id).
The following fields are available for sorting:
idnamemember_countupdated_at
A profile with no published revision has a null member count rather than zero, so sorting by member_count groups those profiles at the null end — first ascending, last descending.
If specified as 1, the meta.count property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next property of the response.
See paging parameters for more information.
0 <= x <= 1A cursor for use in pagination which defines the last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
The number of LocationProfile objects to return. The default is 100 and the maximum is 250.
1 <= x <= 250100
Response
A dictionary with a collection property that contains a list of up to
limit LocationProfile objects matching the query.
A list of LocationProfile objects.
Direct Location Tags and Slot Types expanded through nested fields:* parameters.
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Warehouse-level membership repair freshness. This is the freshness of the authoritative resolved membership, distinct from the Replenishment quantity computation freshness.